home *** CD-ROM | disk | FTP | other *** search
/ Aminet 24 / Aminet 24 (1998)(GTI - Schatztruhe)[!][Apr 1998].iso / Aminet / dev / misc / vahunz.lha / vahunz / vahunz.readme < prev   
Text File  |  1998-02-20  |  2KB  |  99 lines
  1. TITLE
  2.  
  3.   vahunz - Make source code un-/more readable.
  4.  
  5. VERSION 
  6.  
  7.   1.1
  8.  
  9. AUTHOR
  10.  
  11.   Thomas Aglassinger <agi@giga.or.at>
  12.  
  13. DESCRIPTION
  14.  
  15.   Vahunz is a CLI-based replace command that can supersede many words
  16.   across several files with only one invocation.
  17.  
  18.   Normally the target words will be created randomly, turning
  19.   meaningful names into unreadable garbage. For example, a function
  20.   name like read_input_file() could be replaced by g7b() or something
  21.   as useless. Additionally, comments and indention can be removed.
  22.  
  23.   As an option, you can specify certain substitutes, so Vahunz can
  24.   also be applied in a non-destructive manner. This can be used to
  25.   replace inconsistent or unreadable names by something more
  26.   meaningful. Among programmers, this process is known as "The Great
  27.   Renaming".
  28.  
  29. FEATURES
  30.  
  31.   - Stores less/more readable copy in a different directory
  32.   - Supports C, C++ and Java
  33.   - New names since last run are easy to see
  34.   - Names can easily be declared to be modified or left untouched;
  35.     for example, it makes no sense to replace printf().
  36.   - Words being part of comments or string constants are not replaced
  37.   - Fast, as internally names are stored in an AVL-tree
  38.  
  39. NEW FEATURES
  40.  
  41.   - Maintains a second dictionary with names to be ignored
  42.   - Includes some dictionaries with common names to be ignored
  43.   - Supports "The Great Renaming"
  44.   - Added some options to back-trace problems in vahunzed code
  45.   - Several small fixes and improvements
  46.  
  47. SPECIAL REQUIREMENTS
  48.  
  49.   AmigaOS 2.04, 2MB of regular memory, 68020
  50.  
  51. AVAILABILITY
  52.  
  53.   - Every Aminet-mirror, file "dev/misc/vahunz.lha", for example:
  54.  
  55.     ftp://wuarchive.wustl.edu/pub/aminet/dev/misc/vahunz.lha
  56.  
  57.   - http://www.giga.or.at/~agi/vahunz/
  58.  
  59. PRICE
  60.  
  61.   Freeware.
  62.  
  63. DISTRIBUTABILITY
  64.  
  65.   Freely distributable as long the conditions described in the manual
  66.   are met.
  67.  
  68. EXAMPLE
  69.  
  70.   For example,you could have a code excerpt like this:
  71.  
  72.     int main(void)
  73.     {
  74.         while (sepp_age < 83)
  75.         {
  76.             grow_older(sepp_name, &sepp_age);
  77.             print_sepp();
  78.         }
  79.         printf("\n%s died.\n", sepp_name);
  80.         exit(EXIT_SUCCESS);
  81.     }
  82.  
  83.   After vahunzing, this is what it might look like:
  84.  
  85.     int main(void)
  86.     {
  87.     while (g8b < 83)
  88.     {
  89.     z3v(v63, &g8b);
  90.     f_v();
  91.     }
  92.     printf("\n%s died.\n", v63);
  93.     exit(EXIT_SUCCESS);
  94.     }
  95.  
  96.   As you can see, the internal names have been garbled, but the
  97.   symbols of the standard library are preserved.
  98.  
  99.